tools/libs/gnttab: Extensive updates to API documentation.
authorIan Campbell <ian.campbell@citrix.com>
Tue, 22 Sep 2015 11:12:55 +0000 (12:12 +0100)
committerIan Campbell <ian.campbell@citrix.com>
Fri, 22 Jan 2016 12:24:20 +0000 (12:24 +0000)
commit18d46064c37fc734dd9f488fba0ee64d8f90fe07
tree20a3904c49010d4f386b3db86c7d6bc272320111
parentbfddc736f8b4ebadd93330bc0b4342f50de0958d
tools/libs/gnttab: Extensive updates to API documentation.

In particular around error handling, behaviour on fork and the unmap
notification mechanism.

Behaviour of xengnttab_map_*grant_refs and xengntshr_share_pages on
partial failure has been confirmed/inferred (by inspection) on Linux
and Mini-os (the only two known implementations. Likewise the
behaviour of the notification mechanism has been confirmed/inferred
(by inspection) of the Linux implementation (currently the only
implementation) and libvchan (primary known user).

These updates are not folded into "tools: Refactor
/dev/xen/gnt{dev,shr} wrappers into libxengnttab." to try and reduce
the amount of non-movement changes in that patch.

While I'm not convinced by javadoc/doxygen cause the existing comments
which appear to use that syntax to have the appropriate /** marker.

Also fix a typo in a code comment.

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Reviewed-by: Daniel De Graaf <dgdegra@tycho.nsa.gov>
Acked-by: Wei Liu <wei.liu2@citrix.com>
Cc: Daniel De Graaf <dgdegra@tycho.nsa.gov>
tools/libs/gnttab/include/xengnttab.h
tools/libs/gnttab/linux.c